/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.server.biometrics.sensors;

import android.annotation.NonNull;

/**
 * Interface that ClientMonitor holders should use to receive callbacks.
 */
public interface ClientMonitorCallback {
    /**
     * Invoked when the ClientMonitor operation has been started (e.g. reached the head of
     * the queue and becomes the current operation).
     *
     * @param clientMonitor Reference of the ClientMonitor that is starting.
     */
    default void onClientStarted(@NonNull BaseClientMonitor clientMonitor) {}

    /**
     * Invoked when a biometric action has occurred.
     */
    default void onBiometricAction(int action) {}

    /**
     * Invoked when the ClientMonitor operation is complete. This abstracts away asynchronous
     * (i.e. Authenticate, Enroll, Enumerate, Remove) and synchronous (i.e. generateChallenge,
     * revokeChallenge) so that a scheduler can process ClientMonitors regardless of their
     * implementation.
     *
     * @param clientMonitor Reference of the ClientMonitor that finished.
     * @param success       True if the operation completed successfully.
     */
    default void onClientFinished(@NonNull BaseClientMonitor clientMonitor, boolean success) {}
}
